Vcenter Compute Policies Capabilities ClusterScaleInIgnoreVmCapabilities CreateSpec

The Vcenter Compute Policies Capabilities ClusterScaleInIgnoreVmCapabilities CreateSpec schema contains information used to create a new policy to ignore virtual machine capabilities when scaling-in a cluster, see POST /vcenter/compute/policies. When considering scaling-in a cluster, policies that have been created with one of the listed Vcenter Compute Policies Capabilities ClusterScaleInIgnoreVmCapabilities CreateSpec.vm_capabilities are ignored for virtual machines that have the tag indicated by Vcenter Compute Policies Capabilities ClusterScaleInIgnoreVmCapabilities CreateSpec.vm_tag in VMware Cloud on AWS. Usage beyond VMware Cloud on AWS is not supported.

Warning: this schema is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

AllOf

This class requires all of the following:

Vcenter Compute Policies CreateSpec

JSON Example

{
    "capability": "string",
    "name": "string",
    "description": "string",
    "vm_tag": "string",
    "vm_capabilities": [
        "string"
    ]
}

string

vm_tag

Required

When considering scaling-in a cluster, policies that have been created with one of the listed Vcenter Compute Policies Capabilities ClusterScaleInIgnoreVmCapabilities CreateSpec.vm_capabilities are ignored for virtual machines that have this tag.

Warning: this property is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.tagging.Tag:VirtualMachine.

array of string

vm_capabilities

Required

When considering scaling-in a cluster, policies that have been created with one of these capabilities are ignored for virtual machines that have the tag indicated by Vcenter Compute Policies Capabilities ClusterScaleInIgnoreVmCapabilities CreateSpec.vm_tag. This set must contain at least one item. Currently, the only allowed capability identifier is com.vmware.vcenter.compute.policies.capabilities.disable_drs_vmotion. In the future, other capabilities may be specified.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: com.vmware.vcenter.compute.policies.Capability:VirtualMachine. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: com.vmware.vcenter.compute.policies.Capability:VirtualMachine.